GET /api/admin/v1/workspaces
List of workspaces

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "workspaces": [
    {
      "id": 2,
      "name": "Scrum Launch",
      "plan": [
        "pro-bundle"
      ],
      "publish_plan": "Pro Bundle, Nill",
      "subscibed": null,
      "trial_status": "in_progress",
      "workspace_members_count": 2,
      "pending_workspace_invites_count": 1,
      "content_requests_count": 3,
      "content_request_submissions_count": 5,
      "created_at": "2022-10-07T12:27:41.822Z",
      "can_extend_trial_type": false,
      "admin": {
        "id": 9,
        "full_name": "Vadim Kruchina",
        "email": "kruchina.vadim@gmail.com"
      }
    },
    ...
  ],
  "meta": {
    "total_count": 78
  }
}

Params

Param name Description
plan_type
optional

Validations:

  • Must be one of: free, athletic-basic, athletic-pro, athletic-pro-teams, school-basic, school-pro, school-pro-teams, athletic-st-johns, nil, colgate, business, harvard-westlake.
query
optional

Validations:

  • Must be a String
sort_to
optional

Validations:

  • Must be one of: asc, desc.
sort_by
optional

Validations:

  • Must be one of: id, name, created_at, subscribed.
page
optional

Validations:

  • Must be a Integer